mapbox-maps-android/com.mapbox.maps/[androidJvm]Map

Map

class Map : CameraManager, MapInterface

Map class provides map rendering functionality.

Constructors

Map

open fun Map(client: MapClient, mapOptions: MapOptions, resourceOptions: ResourceOptions)

Initializes the map object.

Functions

addPersistentStyleCustomLayer

open fun addPersistentStyleCustomLayer(layerId: String, layerHost: CustomLayerHost, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addPersistentStyleLayer

open fun addPersistentStyleLayer(properties: Value, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addStyleCustomGeometrySource

open fun addStyleCustomGeometrySource(sourceId: String, options: CustomGeometrySourceOptions): Expected<String, None>

Adds a custom geometry to be used in the style.

addStyleCustomLayer

open fun addStyleCustomLayer(layerId: String, layerHost: CustomLayerHost, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addStyleImage

open fun addStyleImage(imageId: String, scale: Float, image: Image, sdf: Boolean, stretchX: List<ImageStretches>, stretchY: List<ImageStretches>, content: ImageContent): Expected<String, None>

Adds an image to be used in the style.

addStyleLayer

open fun addStyleLayer(properties: Value, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addStyleSource

open fun addStyleSource(sourceId: String, properties: Value): Expected<String, None>

Adds a new [style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources).

addViewAnnotation

open fun addViewAnnotation(identifier: String, options: ViewAnnotationOptions): Expected<String, None>

cameraForCoordinateBounds

open fun cameraForCoordinateBounds(bounds: CoordinateBounds, padding: EdgeInsets, bearing: Double, pitch: Double): CameraOptions

Convenience method that returns the `camera options` object for given parameters.

cameraForCoordinates

open fun cameraForCoordinates(coordinates: List<Point>, camera: CameraOptions, box: ScreenBox): CameraOptions

Convenience method that adjusts the provided `camera options` object for given parameters.

open fun cameraForCoordinates(coordinates: List<Point>, padding: EdgeInsets, bearing: Double, pitch: Double): CameraOptions

Convenience method that returns the `camera options` object for given parameters.

cameraForGeometry

open fun cameraForGeometry(geometry: Geometry, padding: EdgeInsets, bearing: Double, pitch: Double): CameraOptions

Convenience method that returns the `camera options` object for given parameters.

clearData

open fun clearData(resourceOptions: ResourceOptions, callback: AsyncOperationResultCallback)

Clears temporary map data.

coordinateBoundsForCamera

open fun coordinateBoundsForCamera(camera: CameraOptions): CoordinateBounds

Returns the `coordinate bounds` for a given camera.

coordinateBoundsZoomForCamera

open fun coordinateBoundsZoomForCamera(camera: CameraOptions): CoordinateBoundsZoom

Returns the `coordinate bounds` and the `zoom` for a given `camera`.

coordinateBoundsZoomForCameraUnwrapped

open fun coordinateBoundsZoomForCameraUnwrapped(camera: CameraOptions): CoordinateBoundsZoom

Returns the unwrapped `coordinate bounds` and `zoom` for a given `camera`.

coordinateForPixel

open fun coordinateForPixel(pixel: ScreenCoordinate): Point

Calculates a geographical `coordinate` (i.e., longitude-latitude pair) that corresponds to a `screen coordinate`.

coordinatesForPixels

open fun coordinatesForPixels(pixels: List<ScreenCoordinate>): List<Point>

Calculates geographical `coordinates` (i.e., longitude-latitude pairs) that correspond to `screen coordinates`.

createRenderer

open fun createRenderer()

Creates the infrastructure needed for rendering the map.

destroyRenderer

open fun destroyRenderer()

Destroys the infrastructure needed for rendering the map, releasing resources.

dragEnd

open fun dragEnd()

Ends the ongoing drag gesture.

dragStart

open fun dragStart(point: ScreenCoordinate)

Prepares the drag gesture to use the provided screen coordinate as a pivot `point`.

getBounds

open fun getBounds(): CameraBounds

Returns the `camera bounds` of the map.

getCameraState

open fun getCameraState(): CameraState

Returns the current `camera state`.

getDebug

open fun getDebug(): List<MapDebugOptions>

Returns the `map debug options`.

getDragCameraOptions

open fun getDragCameraOptions(fromPoint: ScreenCoordinate, toPoint: ScreenCoordinate): CameraOptions

Calculates target point where camera should move after drag.

getElevation

open fun getElevation(coordinate: Point): Double

Gets elevation for the given coordinate.

getFeatureState

open fun getFeatureState(sourceId: String, sourceLayerId: String, featureId: String, callback: QueryFeatureStateCallback)

Gets the state map of a feature within a style source.

getFreeCameraOptions

open fun getFreeCameraOptions(): FreeCameraOptions

Gets the map's current free camera options.

getMapOptions

open fun getMapOptions(): MapOptions

Returns the `map options`.

getMapProjection

open fun getMapProjection(): Value

Returns the currently active map projection and its properties as key-value pairs.

getNativePtr

open fun getNativePtr(): Long

Experimental feature.

getPrefetchZoomDelta

open fun getPrefetchZoomDelta(): Byte

Returns the map's prefetch zoom delta.

getRenderCacheOptions

open fun getRenderCacheOptions(): RenderCacheOptions

Returns the `render cache options` used by the map.

getResourceOptions

open fun getResourceOptions(): ResourceOptions

Gets the resource options for the map.

getSize

open fun getSize(): Size

Gets the size of the map.

getStyleDefaultCamera

open fun getStyleDefaultCamera(): CameraOptions

Returns the map style's default camera, if any, or a default camera otherwise.

getStyleImage

open fun getStyleImage(imageId: String): Image

Get an `image` from the style.

getStyleJSON

open fun getStyleJSON(): String

Get the JSON serialization string of the current style in use.

getStyleLayerProperties

open fun getStyleLayerProperties(layerId: String): Expected<String, Value>

Gets style layer properties.

getStyleLayerProperty

open fun getStyleLayerProperty(layerId: String, property: String): StylePropertyValue

Gets the value of style layer property.

getStyleLayerPropertyDefaultValue

open fun getStyleLayerPropertyDefaultValue(layerType: String, property: String): StylePropertyValue

Gets the default value of style layer property

getStyleLayers

open fun getStyleLayers(): List<StyleObjectInfo>

Returns the existing style layers.

getStyleLightProperty

open fun getStyleLightProperty(property: String): StylePropertyValue

Gets the value of a style light property.

getStyleSourceProperties

open fun getStyleSourceProperties(sourceId: String): Expected<String, Value>

Gets style source properties.

getStyleSourceProperty

open fun getStyleSourceProperty(sourceId: String, property: String): StylePropertyValue

Gets the value of style source property.

getStyleSourcePropertyDefaultValue

open fun getStyleSourcePropertyDefaultValue(sourceType: String, property: String): StylePropertyValue

Gets the default value of style source property.

getStyleSources

open fun getStyleSources(): List<StyleObjectInfo>

Returns the existing style sources.

getStyleTerrainProperty

open fun getStyleTerrainProperty(property: String): StylePropertyValue

Gets the value of a style terrain property.

getStyleTransition

open fun getStyleTransition(): TransitionOptions

Returns the map style's transition options.

getStyleURI

open fun getStyleURI(): String

Get the URI of the current style in use.

getViewAnnotationOptions

open fun getViewAnnotationOptions(identifier: String): Expected<String, ViewAnnotationOptions>

invalidateStyleCustomGeometrySourceRegion

open fun invalidateStyleCustomGeometrySourceRegion(sourceId: String, bounds: CoordinateBounds): Expected<String, None>

Invalidate region for provided custom geometry source.

invalidateStyleCustomGeometrySourceTile

open fun invalidateStyleCustomGeometrySourceTile(sourceId: String, tileId: CanonicalTileID): Expected<String, None>

Invalidate tile for provided custom geometry source.

isGestureInProgress

open fun isGestureInProgress(): Boolean

Returns `true` if a gesture is currently in progress.

isMapLoaded

open fun isMapLoaded(): Boolean

Returns `true` when the map is completely rendered, `false` otherwise.

isStyleLayerPersistent

open fun isStyleLayerPersistent(layerId: String): Expected<String, Boolean>

Checks if a style layer is persistent.

isStyleLoaded

open fun isStyleLoaded(): Boolean

Check if the style is completely loaded.

isUserAnimationInProgress

open fun isUserAnimationInProgress(): Boolean

Returns `true` if user animation is currently in progress.

moveStyleLayer

open fun moveStyleLayer(layerId: String, layerPosition: LayerPosition): Expected<String, None>

Moves an existing style layer

pixelForCoordinate

open fun pixelForCoordinate(coordinate: Point): ScreenCoordinate

Calculates a `screen coordinate` that corresponds to a geographical coordinate (i.e., longitude-latitude pair).

pixelsForCoordinates

open fun pixelsForCoordinates(coordinates: List<Point>): List<ScreenCoordinate>

Calculates `screen coordinates` that correspond to geographical `coordinates` (i.e., longitude-latitude pairs).

queryFeatureExtensions

open fun queryFeatureExtensions(sourceIdentifier: String, feature: Feature, extension: String, extensionField: String, args: HashMap<String, Value>, callback: QueryFeatureExtensionCallback)

Queries for feature extension values in a GeoJSON source.

queryRenderedFeatures

open fun queryRenderedFeatures(geometry: RenderedQueryGeometry, options: RenderedQueryOptions, callback: QueryFeaturesCallback): Cancelable

Queries the map for rendered features.

open fun queryRenderedFeatures(box: ScreenBox, options: RenderedQueryOptions, callback: QueryFeaturesCallback)

Queries the map for rendered features.

open fun queryRenderedFeatures(pixel: ScreenCoordinate, options: RenderedQueryOptions, callback: QueryFeaturesCallback)

Queries the map for rendered features.

open fun queryRenderedFeatures(shape: List<ScreenCoordinate>, options: RenderedQueryOptions, callback: QueryFeaturesCallback)

Queries the map for rendered features.

querySourceFeatures

open fun querySourceFeatures(sourceId: String, options: SourceQueryOptions, callback: QueryFeaturesCallback)

Queries the map for source features.

reduceMemoryUse

open fun reduceMemoryUse()

Reduces memory use.

removeFeatureState

open fun removeFeatureState(sourceId: String, sourceLayerId: String, featureId: String, stateKey: String)

Removes entries from a feature state object.

removeStyleImage

open fun removeStyleImage(imageId: String): Expected<String, None>

Removes an image from the style.

removeStyleLayer

open fun removeStyleLayer(layerId: String): Expected<String, None>

Removes an existing style layer.

removeStyleSource

open fun removeStyleSource(sourceId: String): Expected<String, None>

Removes an existing style source.

removeViewAnnotation

open fun removeViewAnnotation(identifier: String): Expected<String, None>

render

open fun render()

Renders the map.

setBounds

open fun setBounds(options: CameraBoundsOptions): Expected<String, None>

Sets the `camera bounds options` of the map.

setCamera

open fun setCamera(cameraOptions: CameraOptions)

Changes the map view by any combination of center, zoom, bearing, and pitch, without an animated transition.

open fun setCamera(freeCameraOptions: FreeCameraOptions)

Sets the map view with the free camera options.

setConstrainMode

open fun setConstrainMode(mode: ConstrainMode)

Sets the map `constrain mode`.

setDebug

open fun setDebug(debugOptions: List<MapDebugOptions>, value: Boolean)

Sets the `map debug options` and enables debug mode based on the passed value.

setFeatureState

open fun setFeatureState(sourceId: String, sourceLayerId: String, featureId: String, state: Value)

Updates the state object of a feature within a style source.

setGestureInProgress

open fun setGestureInProgress(inProgress: Boolean)

Tells the map rendering engine that there is currently a gesture in progress.

setMapProjection

open fun setMapProjection(projection: Value): Expected<String, None>

Updates the active map projection.

setMemoryBudget

open fun setMemoryBudget(memoryBudget: MapMemoryBudget)

setNorthOrientation

open fun setNorthOrientation(orientation: NorthOrientation)

Sets the north `orientation mode`.

setPrefetchZoomDelta

open fun setPrefetchZoomDelta(delta: Byte)

When loading a map, if prefetch zoom `delta` is set to any number greater than 0, the map will first request a tile at zoom level lower than `zoom - delta`, with requested zoom level a multiple of `delta`, in an attempt to display a full map at lower resolution as quick as possible.

setRenderCacheOptions

open fun setRenderCacheOptions(options: RenderCacheOptions)

Enables or disables the experimental render cache feature.

setSize

open fun setSize(size: Size)

Sets the size of the map.

setStyleCustomGeometrySourceTileData

open fun setStyleCustomGeometrySourceTileData(sourceId: String, tileId: CanonicalTileID, featureCollection: List<Feature>): Expected<String, None>

Set tile data of a custom geometry.

setStyleJSON

open fun setStyleJSON(json: String)

Load the style from a provided JSON string.

setStyleLayerProperties

open fun setStyleLayerProperties(layerId: String, properties: Value): Expected<String, None>

Sets style layer properties.

setStyleLayerProperty

open fun setStyleLayerProperty(layerId: String, property: String, value: Value): Expected<String, None>

Sets a value to a style layer property.

setStyleLight

open fun setStyleLight(properties: Value): Expected<String, None>

Sets the style global [light](https://docs.mapbox.com/mapbox-gl-js/style-spec/#light) properties.

setStyleLightProperty

open fun setStyleLightProperty(property: String, value: Value): Expected<String, None>

Sets a value to the the style light property.

setStyleSourceProperties

open fun setStyleSourceProperties(sourceId: String, properties: Value): Expected<String, None>

Sets style source properties.

setStyleSourceProperty

open fun setStyleSourceProperty(sourceId: String, property: String, value: Value): Expected<String, None>

Sets a value to a style source property.

setStyleTerrain

open fun setStyleTerrain(properties: Value): Expected<String, None>

Sets the style global [terrain](https://docs.mapbox.com/mapbox-gl-js/style-spec/#terrain) properties.

setStyleTerrainProperty

open fun setStyleTerrainProperty(property: String, value: Value): Expected<String, None>

Sets a value to the the style terrain property.

setStyleTransition

open fun setStyleTransition(transitionOptions: TransitionOptions)

Overrides the map style's transition options with user-provided options.

setStyleURI

open fun setStyleURI(uri: String)

Load style from provided URI.

setUserAnimationInProgress

open fun setUserAnimationInProgress(inProgress: Boolean)

Tells the map rendering engine that the animation is currently performed by the user (e.g.

setViewAnnotationPositionsUpdateListener

open fun setViewAnnotationPositionsUpdateListener(listener: ViewAnnotationPositionsUpdateListener)

setViewportMode

open fun setViewportMode(mode: ViewportMode)

Sets the `viewport mode`.

styleLayerExists

open fun styleLayerExists(layerId: String): Boolean

Checks whether a given style layer exists.

styleSourceExists

open fun styleSourceExists(sourceId: String): Boolean

Checks whether a given style source exists.

subscribe

open fun subscribe(observer: Observer, events: List<String>)

Subscribes an `observer` to a provided array of event types.

triggerRepaint

open fun triggerRepaint()

Triggers a repaint of the map.

unsubscribe

open fun unsubscribe(observer: Observer)

Unsubscribes an `observer` from all events.

open fun unsubscribe(observer: Observer, events: List<String>)

Unsubscribes an `observer` from a provided array of event types.

updateStyleImageSourceImage

open fun updateStyleImageSourceImage(sourceId: String, image: Image): Expected<String, None>

Updates the image of an [image style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources-image).

updateViewAnnotation

open fun updateViewAnnotation(identifier: String, options: ViewAnnotationOptions): Expected<String, None>